drivers.h

Go to the documentation of this file.

// Copyright (c) 2014, 2015, 2016, NXP Semiconductors N.V.,
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of NXP Semiconductors N.V. nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL NXP SEMICONDUCTORS N.V. BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//


/*! \file drivers.h
    \brief Provides function prototypes for driver level interfaces

    Users who are not using NXP hardware will need to supply their own drivers
    in place of those defined here.
*/

#ifndef DRIVERS_H
#define DRIVERS_H
#include "Driver_I2C.h"
#include "Driver_SPI.h"

// must #include "sensor_fusion.h" before this file

/// @name SysTick Macros
/// The ARM SysTick counter is used to time various fusion options.  Timings
/// are then conveyed to the NXP Sensor Fusion Toolbox, where they are displayed
/// for the developer.  These functions should be portable to any ARM M0+, M3,
/// M4 or M4F device.  If you are using a different CPU architecture, you will
/// need to provide an equivalent set of macros, remove the macro calls from
/// the fusion routines, or define a set of empty macros.
///@{
void ARM_systick_enable(void);
void ARM_systick_start_ticks(int32_t *pstart);
int32_t ARM_systick_elapsed_ticks(int32_t start_ticks);
void ARM_systick_delay_ms(uint32_t iSystemCoreClock, uint32_t delay_ms);
///@}

/// @name Sensor Drivers
/// Each physical sensor must be provided with one initialization function
/// and one "read" function.  These must be installed by the user using the
/// installSensor method defined in SensorFusionGlobals.  By "physical sensor",
/// we mean either individual sensor type (such as a 3-axis accelerometer) or
/// a combo-sensor such as the NXP FXOS8700 6-axis accel plus mag.  The init()
/// function for each sensor is responsible for initializing all sensors contained
/// in that package.  The read() function is responsible for reading those same
/// sensors and moving the results into the standard structures contained within
/// the SensorFusionGlobals object.
///@{
int8_t MPL3115_Init(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXOS8700_Init(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXAS21002_Init(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t MMA8652_Init(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXLS8952_Init(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t MAG3110_Init(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t MMA8451_Init(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXLS8471Q_Init(PhysicalSensor *sensor, SensorFusionGlobals *sfg);

int8_t MPL3115_Read(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXOS8700_Read(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXAS21002_Read(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t MMA8652_Read(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXLS8952_Read(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t MAG3110_Read(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t MMA8451_Read(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXLS8471Q_Read(PhysicalSensor *sensor, SensorFusionGlobals *sfg);

int8_t MPL3115_Idle(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXOS8700_Idle(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXAS21002_Idle(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t MMA8652_Idle(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXLS8952_Idle(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t MAG3110_Idle(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t MMA8451_Idle(PhysicalSensor *sensor, SensorFusionGlobals *sfg);
int8_t FXLS8471Q_Idle(PhysicalSensor *sensor, SensorFusionGlobals *sfg);

///@}


#endif // DRIVERS_H